/*
 * Copyright © 2020 camunda services GmbH (info@camunda.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.atomix.raft;

/** An election timer controls when a node triggers an election. */
public interface ElectionTimer {

  /**
   * Reset the timer
   *
   * <p>When `reset` is called, the previous timer is cancelled and a new timer will be started.
   * After a specific duration, depending on the implementation, the election will be triggered.
   */
  void reset();

  /** Cancel the timer */
  void cancel();
}
